Delete Entity

Deletes an entity record based on the Id saved within the conversation context

The Edit Connector Task page appears by default on the General tab. Provide a brief relevant description of the task.

For optimal execution time and to conserve database resources, we recommend you select Disable Connector Audit Logging when the integration task involves handling substantial payloads.

Note: “Disable Connector Audit Logging” is available in DRUID version 5.31 and higher and requires Connector upgrade.

Request

Click the Request tab. The Request page provides you with options to define the request body:

set the context / scope (optional)
batch execution entity list
delete by filter

Set the context of the integration task

If you want to perform the integration task in the context of the Request entity set on the connector action, than leave the Scope field set to Global.

If you want to perform the integration task on a context different from the global context set on the connector action, than from the Scope field, select Local and from the Request entity field, select the desired entity.

Using the Local scope, you do all related queries directly inside the connector action instead of building a larger context outside the connector action via additional queries within the Flow Designer to put data inside the request entity and then send the data back to the connector action.

Note: The Scope field is available in DRUID 5.23 and higher.

Batch execution entity list

The Batch execution entity list field lists all the fields of type "Entity list" created on the request entity (all entity lists). From the Batch execution entity list field, select the desired entity field and click the Save button to save the integration task and remain on the page or the Save & Close button to save and return to Connector Steps.

Important! When deleting a batch execution entity list, all children are deleted. For example, if from the Batch execution entity list field, you select "Cases", for the account ID that comes in the conversation context or in a form, all related cases will be deleted.

Hint: You cannot delete by filter if you select an Batch execution entity list

Delete by filter

Note: This feature is available in DRUID 5.23 and higher.

You can delete records based on specific filtering conditions.

The Delete by filter field lists all fields of type entity related with the request entity (that is, the parent entity). From the Delete by filter field, select the desired entity field. In the Filtering area, click on the + icon and select Add new filter.

Define a filtering expression. To provide more filtering conditions, click Add new filter and enter the filtering expression.

Filter Property	Data Type	Description
Field Name	string	From the drop-down, select the field to be filtered.
Operator	string	Specifies the filter operator. Supports the following: contains, not contains, starts with, ends with, =, !=, >, <,>=, <=, in, not in, exists, not exists. Use the adequate operator for the corresponding field type.
Function		Functions you can use to filter data of type string and date: Case Insensitive - Filter data of type string to ensure that results being returned by the query are case-insensitive. Using this function you can enrich the quick search views to enable searching for case insensitive terms. Hint: If you want the query to return both case sensitive and case insensitive results, add filters with and without the Case Insensitive function. Date filtering functions - Filter data of the following types: Date, DateTime, InvariantDateTime and InvariantDate to ensure that results being returned by the query are from a specific day (Today, Yesterday) or within a specific time range (Next X Days, Last X Days, This Week, This Month, Next X Months, Last X Months, This Year, Last Year).
Value	string	Specifies the filtering value. Important! DO NOT provide the value between quotes (e.g., add - 1 instead of "add - 1"). If you want to query for null, then provide null (lowercase, no quotes "").

Example: From [[Account]].Cases delete all accounts that have the status "Active" and the account name contains the word "Jane".

Note: If you select an entity field from Delete by filter and you try saving the integration task without providing a filtering expression, you will get an error message. If you want to delete all the records associated with the request entity, tap on Delete all records and save the integration task.

Test the integration task

Note: In order to test the Delete entity task, you first need to test the Add entity task and from the TestResult copy the value of the entity record Id.

To test the Delete entity integration task, click the Test tab. In the RequestEntity, provide the Id of the entity record you copied from the TestResult of the Add entity task and click the Test button ().